.. _`Compute stereo disparity (OpenCV)`:

.. _`com.sympathyfordata.imageanalysis.disparity`:

Compute stereo disparity (OpenCV)
`````````````````````````````````

.. image:: image_depthdisparity.svg
   :width: 48


Creates a disparity map from a stereo image (two images with an
offset along the x-axis). This disparity map shows how much
each block of pixels in the the first image needs to be
shifted in order to map to the closest block in the other
image. Can be used as a pseudo-depth map.




Documentation
:::::::::::::

Creates a disparity map from a stereo image (two images with an
offset along the x-axis). This disparity map shows how much
each block of pixels in the the first image needs to be
shifted in order to map to the closest block in the other
image. Can be used as a pseudo-depth map.


Definition
::::::::::


Input ports
...........

    **left**  image
        Left image

    **right**  image
        Right image


Output ports
............

    **result**  image
        Result




Configuration
.............

    **Block size** (block_size)
        Size of the blocks compared between the two images. Larger values
        give better matches but a coarser resolution of the resulting
        disparity map. This number must be positive and odd.
    **Max disparity** (max_disparity)
        Largest possible disparity (in pixels), also discards this many
        pixels from the edge of the image since they cannot match a
        corresponding pixel in the other image







Examples
........

* :download:`Depth_from_stereo_images.syx </Examples/Image Analysis/Depth_from_stereo_images.syx>`




Implementation
..............

.. automodule:: node_cv_disparity
    :noindex:

.. class:: ComputeDisparity
    :noindex: